云原生内存数据库Tair有哪些API接口-阿里云帮助中心

本产品（云数据库 Tair（兼容 Redis®）/2015-01-01）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

生命周期管理

API	标题	API概述
CreateInstance	创建实例	创建一个Redis开源版或Tair内存型经典版实例。若要创建云原生型的Tair实例，请使用CreateTairInstance接口。
AddShardingNode	为集群实例添加数据分片节点	为集群实例添加数据分片节点，本接口仅支持集群架构云原生版实例。
CreateGlobalDistributeCache	将存量实例转换为分布式实例中第一个子实例	将一个存量的Tair内存型（经典版）实例转换为分布式实例中第一个子实例。
DeleteShardingNode	删除集群实例中的数据分片节点	删除集群实例中的数据分片节点，本接口仅支持集群架构云原生版实例。
DeleteInstance	释放实例	释放云数据库 Tair（兼容 Redis）实例。
ModifyInstanceSpec	变更实例规格	变更云数据库 Tair（兼容 Redis）实例的规格。
DescribeRegions	查询可用的地域	查询云数据库 Tair（兼容 Redis）实例支持的所有地域及其对应可用区信息。
DescribeZones	查询支持的可用区	查询指定地域下，云数据库 Tair（兼容 Redis）支持的可用区。
DescribeAvailableResource	查询某一可用区的资源列表	查询指定可用区内可创建的实例规格。
TransformToPrePaid	将按量付费转换为包年包月	将按量付费的云数据库 Tair（兼容 Redis）实例转换为包年包月（预付费）实例。
MigrateToOtherZone	迁移实例至其他可用区	将云数据库 Tair（兼容 Redis）实例迁移到同地域内的其它可用区。

实例管理

API	标题	API概述
CreateTairInstance	创建Tair（企业版）实例	创建云原生版的Tair（企业版）实例。
CreateInstances	批量创建实例	批量创建云数据库 Tair（兼容 Redis）经典版实例。
EnableAdditionalBandwidth	调整实例带宽	调整云数据库 Tair（兼容 Redis）实例的带宽，当前仅支持按量付费的计费方式，您仅需填写InstanceId、NodeId（可选）、Bandwidth、ChargeType参数即可。
ModifyInstanceAttribute	修改实例部分信息	修改云数据库 Tair（兼容 Redis）实例的部分信息，包括实例密码、名称等。
ModifyResourceGroup	修改实例所属资源组	修改云数据库 Tair（兼容 Redis）实例所属的资源组。
ModifyInstanceMaintainTime	修改可维护时间段	修改云数据库 Tair（兼容 Redis）实例的可维护时间段，阿里云将在您设定的可维护时间段内对实例进行例行维护。
ModifyInstanceMajorVersion	升级大版本	升级云数据库 Tair（兼容 Redis）实例的大版本。
ModifyInstanceMinorVersion	升级小版本	升级云数据库 Tair（兼容 Redis）实例的小版本。
ModifyDBInstanceAutoUpgrade	修改小版本自动升级开关	修改实例的小版本自动升级开关。
DescribeInstancesOverview	查询实例概览	查询一个或多个云数据库 Tair（兼容 Redis）实例的信息概览。
DescribeInstances	查询实例的列表信息	查询一个或多个云数据库 Tair（兼容 Redis）实例的信息。
DescribeDedicatedClusterInstanceList	查看专属集群实例的列表	查询专属集群中的云数据库 Tair（兼容 Redis）实例信息。
DescribeInstanceAttribute	查询实例的详细信息	查询云数据库 Tair（兼容 Redis）实例的详细信息。
DescribeGlobalDistributeCache	查询分布式实例的详细信息	查询分布式实例的详细信息。
DescribeEngineVersion	查询实例的大版本和小版本信息	查询云数据库 Tair（兼容 Redis）实例的大版本和小版本信息，同时可查询到小版本的发布日志信息。
DescribeRoleZoneInfo	查询节点和所属可用区信息	查询云数据库 Tair（兼容 Redis）实例中各节点的角色、类型、小版本和所属的可用区。
DescribeClusterMemberInfo	查询集群的节点配置信息	查询云数据库 Tair（兼容 Redis）集群实例的节点配置信息（例如规格、最大连接数等）。
DescribeTasks	查询实例某个时间段内所有任务信息	查询云数据库 Tair（兼容 Redis）实例某个时间段内运行的所有任务信息。
DescribeDBInstanceNetInfo	查看实例的网络信息	查看云数据库 Tair（兼容 Redis）实例的网络信息。
DescribeDBNodeDirectVipInfo	查询直连实例子实例的VIP	查询集群版直连实例的子实例VIP（Virtual IP Address）信息。
DescribeLogicInstanceTopology	查询实例的逻辑拓扑结构	查询云数据库 Tair（兼容 Redis）实例的逻辑拓扑结构。
RestartInstance	重启实例	重启运行中的云数据库 Tair（兼容 Redis）实例。
FlushExpireKeys	清除过期Key	清除云数据库 Tair（兼容 Redis）实例中的过期Key。
FlushInstanceForDB	清理实例指定DB的数据	清理云数据库 Tair（兼容 Redis）实例中指定DB的数据。
FlushInstance	清空实例中的数据	清空云数据库 Tair（兼容 Redis）实例中的数据，不可恢复。
SwitchInstanceHA	切换实例HA	执行主从切换（即切换节点角色），可应用于容灾演练、多可用区场景下的应用就近连接等需求。
SyncDtsStatus	设置是否限制实例变配	在使用DTS迁移或同步云数据库 Tair（兼容 Redis）实例的数据前，您可以调用本接口限制该实例执行变配操作，避免因变配引起的数据迁移或同步任务失败。
RemoveSubInstance	将子实例转换为普通实例	将子实例从分布式实例中移除并转变为普通实例（数据会被保留）。
LockDBInstanceWrite	锁定实例写操作	锁定后，实例将仅支持读取数据，不支持写入。
UnlockDBInstanceWrite	解锁实例写锁定操作	对写锁定的实例进行解锁，解锁后，实例支持读取、写入数据。

连接管理

API	标题	API概述
ModifyInstanceNetExpireTime	延长经典网络地址的保留时间	若云数据库 Tair（兼容 Redis）实例之前执行过由经典网络向VPC网络切换，并保留了经典网络连接地址，则可调用本接口延长经典网络连接地址的保留时间。
ModifyDBInstanceConnectionString	修改实例的连接地址和端口	修改云数据库 Tair（兼容 Redis）实例的连接地址和端口。
ModifyIntranetAttribute	调整专属集群中实例的内网带宽	临时调整专属集群中云数据库 Tair（兼容 Redis）实例的内网带宽。
DescribeIntranetAttribute	查询实例的带宽信息	查询云数据库 Tair（兼容 Redis）实例当前的带宽。
SwitchNetwork	切换专有网络VPC或交换机	切换云数据库 Tair（兼容 Redis）实例的专有网络VPC或交换机，如果实例为经典网络，则会将其切换为专有网络。
AllocateInstancePublicConnection	为实例申请公网连接地址	为云数据库 Tair（兼容 Redis）实例申请公网连接地址。
ReleaseInstancePublicConnection	释放公网连接地址	释放云数据库 Tair（兼容 Redis）实例的公网连接地址。
AllocateDirectConnection	申请集群实例的直连地址	申请云数据库 Tair（兼容 Redis）集群实例的直连地址。
ReleaseDirectConnection	释放集群实例的直连地址	释放云数据库 Tair（兼容 Redis）集群实例的直连地址。
SwitchInstanceProxy	开启或关闭集群实例的代理模式	开启或关闭专属集群中云数据库 Tair（兼容 Redis）集群实例的代理模式。

续费管理

API	标题	API概述
ModifyInstanceAutoRenewalAttribute	开启或关闭实例自动续费	开启或者关闭云数据库 Tair（兼容 Redis）实例的到期前自动续费功能。
DescribePrice	查询价格	查询创建、升级配置或续费云数据库 Tair（兼容 Redis）实例等操作产生的费用。
DescribeInstanceAutoRenewalAttribute	查询实例是否开通自动续费	查看云数据库 Tair（兼容 Redis）实例是否开通自动续费。
RenewAdditionalBandwidth	带宽续费	云数据库 Tair（兼容 Redis）实例的带宽已升级为按量付费模式，不再推荐使用本接口。
TransformInstanceChargeType	转换付费类型	转换云数据库 Tair（兼容 Redis）实例的付费类型，支持按量付费和包年包月付费类型之间的相互转换。
RenewInstance	手动续费	为包年包月的云数据库 Tair（兼容 Redis）实例续费。

账号管理

API	标题	API概述
CreateAccount	创建账号	创建云数据库 Tair（兼容 Redis）实例的账号。
DeleteAccount	删除账号	删除云数据库 Tair（兼容 Redis）实例的账号。
ModifyAccountDescription	修改账号的描述	修改云数据库 Tair（兼容 Redis）实例的账号描述。
ModifyAccountPassword	修改账号密码	修改云数据库 Tair（兼容 Redis）实例中指定账号的密码。
DescribeAccounts	查找账号信息	查找指定云数据库 Tair（兼容 Redis）实例列表中某个账号的信息。
ResetAccountPassword	重置密码	重置云数据库 Tair（兼容 Redis）账号的密码。
GrantAccountPrivilege	修改账号的权限	修改云数据库 Tair（兼容 Redis）账号的权限。

备份恢复

API	标题	API概述
CreateBackup	手动备份数据	为云数据库 Tair（兼容 Redis）实例创建数据备份。
ModifyBackupPolicy	修改备份策略设置	修改云数据库 Tair（兼容 Redis）实例的自动备份策略。
DescribeBackupTasks	查询备份任务执行情况	查询云数据库 Tair（兼容 Redis）实例的备份任务执行情况。
DescribeBackupPolicy	查询自动备份策略	查询云数据库 Tair（兼容 Redis）实例的备份策略，包括备份周期、备份时间等。
DescribeBackups	查看备份集列表	查询云数据库 Tair（兼容 Redis）实例的备份文件信息。
RestoreInstance	恢复数据	恢复指定备份文件中的数据到云数据库 Tair（兼容 Redis）实例中。
DescribeClusterBackupList	查询集群实例的备份列表	查询云数据库 Tair（兼容 Redis）集群实例的备份列表。

监控管理

API	标题	API概述
DescribeMonitorItems	查询监控项列表	查询云数据库 Tair（兼容 Redis）实例支持的监控项列表。
DescribeHistoryMonitorValues	查看实例的性能监控信息	查看云数据库 Tair（兼容 Redis）实例的性能监控信息。

日志管理

API	标题	API概述
ModifyAuditLogConfig	修改审计日志设置	开启或修改云数据库 Tair（兼容 Redis）实例的审计日志设置。
DescribeAuditLogConfig	查询审计日志配置	查询云数据库 Tair（兼容 Redis）实例审计日志是否开启、日志保存时间等配置信息。
DescribeAuditRecords	查询实例的审计日志	查询云数据库 Tair（兼容 Redis）实例的审计日志。
DescribeRunningLogRecords	查询实例的运行日志列表	查询云数据库 Tair（兼容 Redis）实例的运行日志。
DescribeSlowLogRecords	查看慢日志明细	查询云数据库 Tair（兼容 Redis）实例在指定时间内产生的慢日志。
InitializeKvstorePermission	授权服务关联角色	为云数据库 Tair（兼容 Redis）授权服务关联角色。

网络安全

API	标题	API概述
ModifySecurityIps	修改IP白名单	设置云数据库 Tair（兼容 Redis）实例的IP白名单。
ModifySecurityGroupConfiguration	设置实例白名单中的安全组	设置云数据库 Tair（兼容 Redis）实例白名单中的安全组。
ModifyInstanceSSL	修改TLS（SSL）配置	为云数据库 Tair（兼容 Redis）实例开启TLS（Transport Layer Security）加密协议配置。
ModifyInstanceVpcAuthMode	修改专有网络免密访问设置	开启或关闭专有网络免密访问。开启后，同一专有网络内的云服务器无需使用密码即可连接云数据库 Tair（兼容 Redis）实例，同时也继续兼容通过用户名和密码的方式连接实例。
DescribeSecurityIps	查询实例的IP白名单	查询云数据库 Tair（兼容 Redis）实例的IP白名单。
DescribeSecurityGroupConfiguration	查询已配置的安全组	查看云数据库 Tair（兼容 Redis）白名单中设置的安全组。
DescribeInstanceSSL	查询是否开启TLS（SSL）加密	查询云数据库 Tair（兼容 Redis）实例是否开启了TLS（SSL）加密认证。

参数管理

API	标题	API概述
ModifyInstanceConfig	修改实例的参数配置	修改云数据库 Tair（兼容 Redis）实例的参数配置。
DescribeParameterTemplates	查询参数列表和默认值	查询云数据库 Tair（兼容 Redis）实例在不同架构和大版本下的参数列表和默认值。
DescribeInstanceConfig	查询实例参数配置	查询云数据库 Tair（兼容 Redis）实例的部分默认配置参数信息。
DescribeParameters	查询实例的配置参数和运行参数	查询云数据库 Tair（兼容 Redis）实例的配置参数和运行参数。
DescribeParameterModificationHistory	查询参数修改历史	查询云数据库 Tair（兼容 Redis）实例的参数修改历史。

标签管理

API	标题	API概述
ListTagResources	查询标签列表	查询云数据库 Tair（兼容 Redis）实例和标签的绑定关系。
TagResources	为一个或多个实例绑定标签	为一个或多个云数据库 Tair（兼容 Redis）实例绑定标签。
UntagResources	为实例解绑标签	将标签从云数据库 Tair（兼容 Redis）实例解绑。

性能优化

API	标题	API概述
CreateCacheAnalysisTask	创建缓存分析任务	手动发起实例缓存分析任务。
DescribeCacheAnalysisReport	查看实例缓存分析报告	查看实例在指定日期中的缓存分析报告。
DescribeCacheAnalysisReportList	查询实例的缓存分析报告列表	查询实例的缓存分析报告列表。

数据加密

API	标题	API概述
ModifyInstanceTDE	开启透明数据加密TDE	为云数据库 Tair（兼容 Redis）实例开启透明数据加密TDE功能，支持自定义密钥。
DescribeInstanceTDEStatus	查询实例是否开启TDE加密	查询云数据库 Tair（兼容 Redis）实例是否开启了TDE加密功能。
DescribeEncryptionKeyList	查询实例的自定义密钥列表	查询云数据库 Tair（兼容 Redis）实例使用的自定义密钥列表。
DescribeEncryptionKey	查询实例的TDE自定义密钥详情	查询云数据库 Tair（兼容 Redis）实例的透明数据加密TDE自定义密钥的详情。
CheckCloudResourceAuthorized	查询是否已授权KMS密钥	查询云数据库 Tair（兼容 Redis）实例是否已被授权使用KMS密钥服务。

运维任务管理

API	标题	API概述
DescribeHistoryTasks	查询历史运维任务	查看任务中心的任务列表。

白名单模板管理

API	标题	API概述
CreateGlobalSecurityIPGroup	创建IP白名单模板	创建全局IP白名单模板。
ModifyGlobalSecurityIPGroupName	修改IP白名单模板名称	修改全局IP白名单模板的名称。
DescribeGlobalSecurityIPGroupRelation	查询实例关联的IP白名单模板信息	查询实例关联的全局IP白名单模板信息。
DeleteGlobalSecurityIPGroup	删除IP白名单模板	删除全局IP白名单模板。
ModifyGlobalSecurityIPGroup	修改IP白名单模板	修改全局IP白名单模板。
ModifyGlobalSecurityIPGroupRelation	将实例添加到IP白名单模板中	将指定实例添加到指定的IP白名单模板中。
DescribeGlobalSecurityIPGroup	查询IP白名单模板列表	查询全局IP白名单模板列表。

参数模板管理

API	标题	API概述
ModifyInstanceParameter	应用参数模板到实例	将参数模板应用至指定实例，表示将参数模板的值赋于指定的实例中。当您修改参数模版后，您也需要重新应用至指定实例，才能将修改后的参数值赋于指定实例。
DeleteParameterGroup	删除参数模板	删除参数模板。
DescribeParameterGroupSupportParam	参数模版支持设置的参数列表	查询在不同版本的参数模版中支持设置的参数列表。
DescribeParameterGroup	查询参数模版基本信息	查询参数模版基本信息。
ModifyParameterGroup	修改参数模版	修改参数模板的设置。
DescribeParameterGroups	查询参数模版列表	查询可用的参数模版列表。
CreateParameterGroup	创建参数模板	创建参数模板。
DescribeParameterGroupTemplateList	参数模版系统参数	查询参数模板中可配置参数的具体信息，例如默认值、取值范围、描述等。

事件管理

API	标题	API概述
DescribeActiveOperationTasks	查询多个主动运维事件信息	查询实例的运维事件详情。
ModifyActiveOperationTasks	修改运维事件的计划切换时间	修改实例计划内运维事件的切换时间。
CancelActiveOperationTasks	取消运维事件	批量取消运维事件。

故障模拟

API	标题	API概述
SwitchInstanceZoneFailOver	模拟可用区级别故障切换	模拟云数据库 Tair（兼容 Redis）集群架构实例发生可用区级别故障，实例将自动切换到备可用区中。
MasterNodeShutDownFailOver	模拟指定节点故障	模拟云数据库 Tair（兼容 Redis）的指定数据节点或Proxy节点故障，实例将自动进行主备切换，保证高可用。

其他

API	标题	API概述
ModifyInstanceBandwidth	修改实例的带宽	设置云数据库 Tair（兼容 Redis）实例的目标带宽值。
ModifyTaskInfo	修改任务操作	进行任务操作，当前支持修改任务执行时间点。